跳至主要内容
版本：V4.0

設備管理API

獲取設備列表​

接口地址​

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
project_idStringBody是項目ID
page_sizeIntegerBody是每頁數量
page_indexIntegerBody是當前頁數

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
result[]Object<result>Body返回結果

result說明​

參數名類型位置說明
residence_idStringBody住宅ID
family_nameStringBody家庭名稱
residence_noStringBody住宅號碼
building_idStringBody樓棟ID
building_nameStringBody樓棟名稱
device_idStringBody設備ID
device_nameStringBody設備名稱
macStringBodyMAC地址
connected_timeStringBody連接時間，UTC
first_nameStringBody名
last_nameStringBody姓
onlineBooleanBody判斷設備在離線狀態
true：在線
false：離線
sipStringBodySIP號
device_typeStringBody判斷設備類型
Multi-tenants Doorphone：梯口機
Single-tenant Doorphone：門口機
Indoor Monitor：室內機
Guard Phone：管理機
Access Control：門禁

請求示例​

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_device_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724802057424,
  "result": [
    {
      "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
      "device_name": "test",
      "mac": "C10519082089",
      "connected_time": "2024-01-26 04:59:20",
      "first_name": "Fly",
      "last_name": "Dom",
      "residence_id": "r2c4b070cc928496198944858b344fc68",
      "family_name": "test",
      "residence_no": "101",
      "building_id": "b1a621c1ae77040d697bd2134700f57ee",
      "building_name": "AB01",
      "online": true,
      "sip": "123132312",
      "device_type": "Multi-tenants Doorphone"
    }
  ]
}

失敗返回示例​

見 接口失敗返回


獲取設備信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
project_idStringBody是項目ID
device_idStringBody是設備ID

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
resultObject<result>Body返回結果

result說明​

參數名類型位置說明
residence_idStringBody住宅ID
family_nameStringBody家庭名稱
residence_noStringBody住宅號碼
building_idStringBody樓棟ID
building_nameStringBody樓棟名稱
device_nameStringBody設備名稱
macStringBodyMAC地址
connected_timeStringBody連接時間，UTC
first_nameStringBody名
last_nameStringBody姓
onlineBooleanBody判斷設備在離線狀態
true：在線
false：離線
sipStringBodySIP號
device_typeStringBody判斷設備類型
Multi-tenants Doorphone：梯口機
Single-tenant Doorphone：門口機
Indoor Monitor：室內機
Guard Phone：管理機
Access Control：門禁
allow_monitorBooleanBody判斷是否爲允許監控
true：允許
false：不允許
is_publicBooleanBody判斷是否爲公共設備
true：是
false：否
relays[]Object<relay>Body門控信息
security_relays[]Object<relay>Body安全門控信息
firmware_versionStringBody固件版本
hardware_versionStringBody硬件版本
ip_addressStringBodyIP地址
subnet_maskStringBody子網掩碼
gatewayStringBody網關
primary_dnsStringBody首選DNS
secondary_dnsStringBody備選DNS
permission_buildings[]Object<permission_building>Body授權樓棟信息

permission_building說明​

參數名類型位置說明
building_idStringBody樓棟ID
building_nameStringBody樓棟名稱

relay說明​

參數名類型位置說明
relay_nameStringBody門控名稱
relay_numberStringBody門控撥號鍵值
relay_idStringBody門控ID
enableBooleanBody判斷是否啓用門控
true：啓用
false：禁用
access_controlObject<access_control>Body權限控制
show_homeBooleanBody判斷是否展示家庭
true：展示
false：不展示
show_talkingBooleanBody判斷是否展示通話
true：展示
false：不展示
scheduleObject<schedule>Body日程信息

access_control說明​

參數名類型位置說明
enable_pinBooleanBody判斷是否啓用PIN碼
true：啓用
false：禁用
enable_rf_cardBooleanBody判斷是否啓用射頻卡
true：啓用
false：禁用
enable_faceBooleanBody判斷是否啓用人臉
true：啓用
false：禁用
enable_bleBooleanBody判斷是否啓用藍牙
true：啓用
false：禁用
enable_nfcBooleanBody判斷是否啓用NFC
true：啓用
false：禁用

schedule說明​

參數名類型位置說明
enableBooleanBody判斷是否啓用日程
true：啓用
false：禁用
access[]StringBody權限

請求示例​

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_device_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "device_id": "d131adc223cc4b3bedb6bd4742dedcfa5",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724802105380,
  "result": {
    "device_name": "test",
    "mac": "C10519082089",
    "connected_time": "2024-01-26 04:59:20",
    "first_name": "Fly",
    "last_name": "Dom",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "family_name": "test",
    "residence_no": "101",
    "building_id": "b1a621c1ae77040d697bd2134700f57ee",
    "building_name": "AB01",
    "online": true,
    "sip": "123132312",
    "device_type": "Multi-tenants Doorphone",
    "allow_monitor": true,
    "is_public": true,
    "relays": [
      {
        "relay_name": "Front Door 3",
        "relay_number": "#",
        "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2",
        "enable": true,
        "access_control": {
          "enable_pin": true,
          "enable_rf_card": true,
          "enable_face": true,
          "enable_ble": true,
          "enable_nfc": true
        },
        "show_home": true,
        "show_talking": true,
        "schedule": {
          "enable": false,
          "access": []
        }
      }
    ],
    "security_relays": [],
    "firmware_version": "71.123.37.5",
    "hardware_version": "1.0",
    "ip_address": "192.168.18.171",
    "subnet_mask": "255.255.255.0",
    "gateway": "192.168.18.1",
    "primary_dns": "",
    "secondary_dns": "",
    "permission_buildings": [
      {
        "building_id": "bafa332e258aae1badbb27d31128f442d",
        "building_name": "001"
      }
    ]
  }
}

失敗返回示例​

見 接口失敗返回


更新設備信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
project_idStringBody是項目ID
device_idStringBody是設備ID
device_nameStringBody是設備名稱
macStringBody是MAC地址
allow_monitorBooleanBody是判斷是否爲允許監控
true：允許
false：不允許
relays[]Object<relay>Body否門控信息
security_relays[]Object<relay>Body否安全門控信息

relay說明​

參數名類型位置必填說明
relay_nameStringBody是門控名稱
relay_numberStringBody是門控撥號鍵值
relay_idStringBody是門控ID
enableBooleanBody是判斷是否啓用門控
true：啓用
false：禁用
access_controlObject<access_control>Body是權限控制
show_homeBooleanBody是判斷是否展示家庭
true：展示
false：不展示
show_talkingBooleanBody是判斷是否展示通話
true：展示
false：不展示
scheduleObject<schedule>Body是日程信息

access_control說明​

參數名類型位置必填說明
enable_pinBooleanBody是判斷是否啓用PIN碼
true：啓用
false：禁用
enable_rf_cardBooleanBody是判斷是否啓用射頻卡
true：啓用
false：禁用
enable_faceBooleanBody是判斷是否啓用人臉
true：啓用
false：禁用
enable_bleBooleanBody是判斷是否啓用藍牙
true：啓用
false：禁用
enable_nfcBooleanBody是判斷是否啓用NFC
true：啓用
false：禁用

schedule說明​

參數名類型位置必填說明
enableBooleanBody是判斷是否啓用日程
true：啓用
false：禁用
access[]StringBody是權限

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
resultObjectBody返回結果

請求示例​

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_device_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa22",
    "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
    "mac": "C10519082089",
    "device_name": "test",
    "allow_monitor": true,
    "relays": [
      {
        "relay_name": "Front Door 3",
        "relay_number": "#",
        "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2",
        "enable": true,
        "access_control": {
          "enable_pin": true,
          "enable_rf_card": true,
          "enable_face": true,
          "enable_ble": true,
          "enable_nfc": true
        },
        "show_home": true,
        "show_talking": true,
        "schedule": {
          "enable": false,
          "access": []
        }
      }
    ],
    "security_relays": []
  }
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例​

見 接口失敗返回


獲取通話歷史記錄​

接口地址​

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
project_idStringBody是項目ID
page_sizeIntegerBody是每頁數量
page_indexIntegerBody是當前頁數
start_timeStringBody是開始時間，UTC
finish_timeStringBody是結束時間，UTC

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
result[]Object<result>Body返回結果

result說明​

參數名類型位置說明
caller_nameStringBody通話方名稱
callee_nameStringBody接收方名稱
call_timeStringBody通話時間
call_durationIntegerBody通話時長，單位：秒

請求示例​

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_call_history",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "start_time": "2024-01-16 13:32:45",
    "finish_time": "2024-01-17 13:32:45",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例​

狀態碼：200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "caller_name": "IT83_alq_180",
      "callee_name": "Jim",
      "call_time": "2024-01-16 17:32:43",
      "call_duration": 10
    }
  ]
}

失敗返回示例​

見 接口失敗返回


獲取開門歷史記錄​

接口地址​

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
project_idStringBody是項目ID
page_sizeIntegerBody是每頁數量
page_indexIntegerBody是當前頁數
start_timeStringBody是開始時間，UTC
finish_timeStringBody是結束時間，UTC

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
result[]Object<result>Body返回結果

result說明​

參數名類型位置說明
open_doorBooleanBody判斷開門是否成功
true：成功
false：失敗
account_nameStringBody賬號名稱
device_nameStringBody設備名稱
capture_thumbnail_urlStringBody抓拍縮略圖地址
open_door_typeStringBody開門類型
capture_picture_urlStringBody抓拍圖地址
open_door_timeStringBody開門時間
residence_idStringBody住宅ID
family_nameStringBody家庭名稱
residence_noStringBody住宅號碼
building_idStringBody樓棟ID
building_nameStringBody樓棟名稱

請求示例​

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_open_door_history",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "start_time": "2024-01-16 13:32:45",
    "finish_time": "2024-01-17 13:32:45",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例​

狀態碼：200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "open_door": true,
      "account_name": "tom",
      "device_name": "R29",
      "capture_thumbnail_url": "https://test.akuvox.com/r.jpg",
      "open_door_type": "",
      "capture_picture_url": "https://test.akuvox.com/d.jpg",
      "open_door_time": "2024-01-16 15:25:45",
      "residence_id": "r2c4b070cc928496198944858b344fc68",
      "family_name": "test",
      "residence_no": "101",
      "building_id": "b1a621c1ae77040d697bd2134700f57ee",
      "building_name": "AB01"
    }
  ]
}

失敗返回示例​

見 接口失敗返回


批量觸發遠程開門​

接口地址​

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
project_idStringBody是項目ID
devices[]Object<device>Body是設備信息

device說明​

參數名類型位置必填說明
macStringBody是MAC地址
relay_idStringBody是門控ID

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
resultObjectBody返回結果

請求示例​

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_trigger_remote_open_door",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "devices": [
      {
        "mac": "0C110508EF2E",
        "relay_id": "rr31adc223cc4b3bedb6bd4742dedcfa5"
      }
    ]
  }
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例​

見 接口失敗返回


配置設備Autop​

接口地址​

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
project_idStringBody是項目ID
macStringBody是MAC地址
configStringBody是配置

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
resultObjectBody返回結果

請求示例​

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "configure_device_autop",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": [
    {
      "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
      "mac": "0C110508EF2E",
      "config": "test"
    }
  ]
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例​

見 接口失敗返回